Vcenter Vm Tools Info

Vcenter Vm Tools Info
Vcenter Vm Tools Info

The Vcenter Vm Tools Info schema describes the VMWare Tools properties of a virtual machine.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "auto_update_supported": false,
    "install_attempt_count": 0,
    "error": {},
    "version_number": 0,
    "version": "string",
    "upgrade_policy": "string",
    "version_status": "string",
    "install_type": "string",
    "run_state": "string"
}
boolean
auto_update_supported
Required

Set if the virtual machine supports auto-upgrading Tools via Vcenter Vm Tools UpgradePolicy.

This property was added in vSphere API 7.0.0.0.

integer As int64 As int64
install_attempt_count
Optional

Number of attempts that have been made to install or upgrade the version of Tools installed on this virtual machine.

This property was added in vSphere API 7.0.0.0.

This property will be missing or null if there have been no Tools install or upgrade attempt.

object
error
Optional

Error that happened, if any, during last attempt to upgrade or install Tools.

This property was added in vSphere API 7.0.0.0.

This property will be missing or null if a the last Tools install or upgrade attempt succeeded.

integer As int64 As int64
version_number
Optional

Version of VMware Tools installed on the guest operating system.

This property was added in vSphere API 7.0.0.0.

This property wil be missing or null if VMWare Tools is not installed. This is an integer constructed as follows: (((MJR) << 10) + ((MNR) << 5) + (REV)) Where MJR is tha major verson, MNR is the minor version and REV is the revision. Tools version = T Tools Version Major = MJR = (T / 1024) Tools Version Minor = MNR = ((T % 1024) / 32) Tools Version Revision = BASE = ((T % 1024) % 32) Tools actual version = MJR.MNR.REV

string
version
Optional

Version of VMware Tools installed on the guest operating system. This is a human-readable value that should not be parsed.

This property was added in vSphere API 7.0.0.0.

This property wil be missing or null if VMWare Tools is not installed.

string
upgrade_policy
Required

Tools upgrade policy setting for the virtual machine. Vcenter Vm Tools UpgradePolicy

For more information see: Vcenter Vm Tools UpgradePolicy.

This property was added in vSphere API 7.0.0.0.

string
version_status
Optional

Current version status of VMware Tools in the guest operating system, if known.

For more information see: Vcenter Vm Tools VersionStatus.

This property was added in vSphere API 7.0.0.0.

This property will be missing or null if the version status is not known, for example if VMware Tools is too old to report the information.

string
install_type
Optional

Current installation type of VMware Tools in the guest operating system.

For more information see: Vcenter Vm Tools ToolsInstallType.

This property was added in vSphere API 7.0.0.0.

This property will be missing or null if the installation type is not known, for example if VMware Tools is too old to report the information.

string
run_state
Required

Current run state of VMware Tools in the guest operating system.

For more information see: Vcenter Vm Tools RunState.

This property was added in vSphere API 7.0.0.0.

Returned By